call_analysis.call_summary

transcript

transcript_object

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const callResponse = await client.call.retrieve('119c3f8e47135a29e65947eeb34cf12d') ;
console.log(callResponse) ;

call_analysis

json
"call_analysis": {
  "call_summary": "The agent called the user to ask question about his purchase inquiry...",
  "user_sentiment": "Positive",
  "call_successful": true
}

data_storage_setting

everything

everything_except_pii

basic_attributes_only

scrubbed_transcript_with_tool_calls

scrubbed_recording_url

call_analyzed

analysis_summary_prompt

analysis_summary_prompt

json
"analysis_summary_prompt": "Summarize the outcome of the conversation in two sentences."

json
"analysis_summary_prompt": "Summarize the call in a few sentences."

null

call_analysis

disconnection_reason

user_hangup

agent_hangup

inactivity

max_duration_reached

dial_no_answer

ended

call_status

disconnection_reason

call_status

ended

not_connected

disconnection_reason

user_hangup

agent_hangup

call_transfer

dial_no_answer

dial_busy

user_declined

marked_as_spam

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const callResponse = await client.call.retrieve('119c3f8e47135a29e65947eeb34cf12d') ;
console.log(callResponse) ;

callResponse.call_status

callResponse.disconnection_reason

call_ended

call_ended

call_ended

disconnection_reason

json
{
  "event": "call_ended",
  "call": {
    "call_type": "phone_call",
    "from_number": "+12137771234",
    "to_number": "+12137771235",
    "direction": "inbound",
    "call_id": "Jabr9TXYYJHfvl6Syypi88rdAHYHmcq6",
    "agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
    "call_status": "registered",
    "metadata": {},
    "retell_llm_dynamic_variables": {
      "customer_name": "John Doe"
    },
    "start_timestamp": 1714608475945,
    "end_timestamp": 1714608491736,
    "disconnection_reason": "user_hangup",
    "transcript": "...",
    "transcript_object": [ [Object], [Object], [Object], [Object] ],
    "transcript_with_tool_calls": [ [Object], [Object], [Object], [Object] ],
    "opt_out_sensitive_data_storage": false
  }
}

dial_failed

dial_no_answer

dial_busy

call_started

call_ended

disconnection_reason

call_ended

call_status

ongoing

call_status

registered

ongoing

ended

error

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const callResponse = await client.call.retrieve('119c3f8e47135a29e65947eeb34cf12d') ;
console.log(callResponse) ;

callResponse.call_status

ongoing

call_status

client.call.retrieve(call_id)

call_started

call_ended

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const callResponse = await client.call.retrieve('119c3f8e47135a29e65947eeb34cf12d') ;
console.log(callResponse) ;

call_status

registered

ongoing

ended

error

ongoing

ongoing

webhook_url

webhook_url

json
"webhook_url": "<https://webhook-url-here%22>

null

webhook_timeout_ms

webhook_url

call_started

call_ended

call_analyzed

call_started

call_ended

call_analyzed

webhook_url

json
"webhook_url": "<https://webhook-url-here%22>

event

json
{
  "event": "call_ended",
  "call": {
    ...
  }
}

event

call_started

call_ended

call_analyzed

webhook_url

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const agentResponse = await client.agent.create({
  response_engine: { llm_id: 'llm_234sdertfsdsfsdf', type: 'retell-llm' },
  voice_id: '11labs-Adrian',
}) ;
console.log(agentResponse.agent_id) ;

webhook_url

json
"webhook_url": "<https://webhook-url-here%22>

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const chatAgentResponse = await client.chatAgent.update('16b980523634a6dc504898cda492e939') ;
console.log(chatAgentResponse.agent_id) ;

webhook_url

null

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const agentResponse = await client.agent.create({
  response_engine: { llm_id: 'llm_234sdertfsdsfsdf', type: 'retell-llm' },
  voice_id: '11labs-Adrian',
}) ;
console.log(agentResponse.agent_id) ;

javascript
const phoneNumberResponse = await retell.phoneNumber.create({
  inbound_agent_id: "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD", // replace with the agent id you want to assign
  outbound_agent_id: "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD", // replace with the agent id you want to assign
}) ;
console.log(phoneNumberResponse) ;

area_code

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const phoneNumberResponse = await client.phoneNumber.update('+14157774444', {
  inbound_agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
  nickname: 'Frontdesk Number',
  outbound_agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
}) ;
console.log(phoneNumberResponse.inbound_agent_id) ;

analysis_summary_prompt

PATCH /update-agent/{agent_id}

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const agentResponse = await client.agent.update('16b980523634a6dc504898cda492e939', {
  agent_name: 'Jarvis',
}) ;
console.log(agentResponse.agent_id) ;

analysis_summary_prompt

json
"analysis_summary_prompt": "Summarize the outcome of the conversation in two sentences."

analysis_summary_prompt

null

analysis_summary_prompt

analysis_summary_prompt

PATCH /update-agent/{agent_id}

null

<https://dashboard.retellai.com/agents/agent_id>

agent_id

agent_id

/v2/update-agent/

/update-agent/

/v2/

PATCH /update-agent/{agent_id}

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const agentResponse = await client.agent.update('16b980523634a6dc504898cda492e939', {
  agent_name: 'Jarvis',
}) ;
console.log(agentResponse.agent_id) ;

/update-agent/{agent_id}

/v2/

<https://api.retellai.com/update-agent/agent_00c700ca8d77ecea0c04e78ce7>

analysis_summary_prompt_length

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const agentResponse = await client.agent.create({
  response_engine: { llm_id: 'llm_234sdertfsdsfsdf', type: 'retell-llm' },
  voice_id: '11labs-Adrian',
}) ;
console.log(agentResponse.agent_id) ;

javascript
const phoneNumberResponse = await client.phoneNumber.update('+14157774444', {
  inbound_agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
  nickname: 'Frontdesk Number',
}) ;

inbound_agent_id

outbound_agent_id

inbound_agent_id

outbound_agent_id

PATCH /update-phone-number/{phone_number}

javascript
import Retell from 'retell-sdk';
const client = new Retell({
 apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const phoneNumberResponse = await client.phoneNumber.update('+14157774444', {
 inbound_agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
 nickname: 'Frontdesk Number',
 outbound_agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
}) ;
console.log(phoneNumberResponse.inbound_agent_id) ;

null

null

agent_id

client.phoneNumber.update()

+14157774444

inbound_agent_id

outbound_agent_id

/v2/create-agent

/v2/

POST /create-agent

<https://api.retellai.com/create-agent>

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const agentResponse = await client.agent.create({
  response_engine: { llm_id: 'llm_234sdertfsdsfsdf', type: 'retell-llm' },
  voice_id: '11labs-Adrian',
}) ;
console.log(agentResponse.agent_id) ;

voice_id

11labs-Adrian

/update-phone-number

PATCH /update-phone-number/{phone_number}

/update-phone-number

<https://api.retellai.com/update-phone-number/+14157774444>

javascript
const phoneNumberResponse = await client.phoneNumber.update('+14157774444', {
 inbound_agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
 nickname: 'Frontdesk Number',
 outbound_agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
}) ;

+14157774444

POST /create-agent

response_engine

llm_id

json
"response_engine": {
  "type": "retell-llm",
  "llm_id": "llm_234sdertfsdsfsdf",
  "version": 0
}

voice_id

javascript
voice_id: '11labs-Adrian',

'11labs-Adrian'

agent_name

json
"agent_name": "Jarvis"

response_engine

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const agentResponse = await client.agent.create({
  response_engine: { llm_id: 'llm_234sdertfsdsfsdf', type: 'retell-llm' },
  voice_id: '11labs-Adrian',
}) ;
console.log(agentResponse.agent_id) ;

agent_name

agent_name

agent_name

javascript
const agentResponse = await client.agent.create({
  response_engine: { llm_id: 'llm_234sdertfsdsfsdf', type: 'retell-llm' },
  voice_id: '11labs-Adrian',
  agent_name: 'Jarvis',
}) ;

javascript
const agentResponse = await client.agent.update('16b980523634a6dc504898cda492e939', {
  agent_name: 'Jarvis',
}) ;

agent_name

string | null

agent_name

analysis_summary_prompt

response_engine

llm_id

llm_id

nodes

javascript
import Retell from 'retell-sdk';
const client = new Retell({
 apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const conversationFlowResponse = await client.conversationFlow.create({
 model_choice: { model: 'gpt-4.1', type: 'cascading' },
 nodes: [
 {
 id: 'start',
 instruction: { text: 'Greet the customer and ask how you can help them.', type: 'prompt' },
 type: 'conversation',
 },
 ],
 start_speaker: 'agent',
}) ;
console.log(conversationFlowResponse.conversation_flow_id) ;

nodes

id

type

instruction

response_engine

llm_id

general_prompt

general_prompt

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const llmResponse = await client.llm.create() ;
console.log(llmResponse.llm_id) ;

general_prompt

json
{
  "general_prompt": "You are ..."
}

PATCH /update-retell-llm/{llm_id}

general_prompt

general_prompt

PATCH /update-retell-llm/{llm_id}

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const llmResponse = await client.llm.update('16b980523634a6dc504898cda492e939', {
  begin_message: 'Hey I am a virtual assistant calling from Retell Hospital.',
}) ;
console.log(llmResponse.llm_id) ;

begin_message

general_prompt

json
{
  "general_prompt": "You are ..."
}

general_prompt

string | null

webhook_url

PATCH /update-agent/{agent_id}

javascript
import Retell from 'retell-sdk';
const client = new Retell({
 apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const agentResponse = await client.agent.update('16b980523634a6dc504898cda492e939', {
 agent_name: 'Jarvis',
}) ;
console.log(agentResponse.agent_id) ;

agent_name

webhook_url

json
{
  "webhook_url": "<https://webhook-url-here%22>
}

webhook_url

string | null

null

webhook_url

webhook_url

string | null

null

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const agentResponse = await client.agent.create({
  response_engine: { llm_id: 'llm_234sdertfsdsfsdf', type: 'retell-llm' },
  voice_id: '11labs-Adrian',
}) ;
console.log(agentResponse.agent_id) ;

webhook_url

json
{
  "response_engine": { "llm_id": "llm_234sdertfsdsfsdf", "type": "retell-llm" },
  "voice_id": "11labs-Adrian",
  "webhook_url": "<https://webhook-url-here%22>
}

general_prompt

general_prompt

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const llmResponse = await client.llm.retrieve('16b980523634a6dc504898cda492e939') ;
console.log(llmResponse.llm_id) ;

general_prompt

Draft

get_agent(version=2) # Gets the version with version number 2.
get_agent() # Gets the latest version of the agent.

create_phone_number

Draft

llm_id

llm_id

POST /create-retell-llm

llm_id

llm_id

response_engine

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const agentResponse = await client.agent.create({
  response_engine: { llm_id: 'llm_234sdertfsdsfsdf', type: 'retell-llm' },
  voice_id: '11labs-Adrian',
}) ;
console.log(agentResponse.agent_id) ;

llm_id

llm_id

response_engine

analysis_summary_prompt

analysis_summary_prompt

javascript
const agentResponse = await client.agent.create({
  response_engine: { llm_id: 'llm_234sdertfsdsfsdf', type: 'retell-llm' },
  voice_id: '11labs-Adrian',
  analysis_summary_prompt: 'Summarize the outcome of the conversation in two sentences.',
}) ;

javascript
const agentResponse = await client.agent.update('16b980523634a6dc504898cda492e939', {
  analysis_summary_prompt: 'Summarize the outcome of the conversation in two sentences.',
}) ;

analysis_summary_prompt

string | null

null

2000

global_prompt

javascript
import Retell from 'retell-sdk';
const client = new Retell({
 apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const conversationFlowResponse = await client.conversationFlow.create({
 model_choice: { model: 'gpt-4.1', type: 'cascading' },
 nodes: [
 {
 id: 'start',
 instruction: { text: 'Greet the customer and ask how you can help them.', type: 'prompt' },
 type: 'conversation',
 },
 ],
 start_speaker: 'agent',
}) ;
console.log(conversationFlowResponse.conversation_flow_id) ;

global_prompt

json
{
  "global_prompt": "You are a helpful customer service agent."
}

global_prompt

string | null

Create Conversation Flow

conversation_flow_id

Create Retell LLM

llm_id

Skip Response

Block Interruptions

client.conversationFlow.create

conversation_flow_id

response_engine

javascript
import Retell from 'retell-sdk';
const client = new Retell({
 apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const conversationFlowResponse = await client.conversationFlow.create({
 model_choice: { model: 'gpt-4.1', type: 'cascading' },
 nodes: [
 {
 id: 'start',
 instruction: { text: 'Greet the customer and ask how you can help them.', type: 'prompt' },
 type: 'conversation',
 },
 ],
 start_speaker: 'agent',
}) ;
console.log(conversationFlowResponse.conversation_flow_id) ;

conversation_flow_id

response_engine

conversation-flow

llm_id

retell-llm

response_engine

conversation-flow

conversation_flow_id

javascript
import Retell from 'retell-sdk';
const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const agentResponse = await client.agent.create({
  response_engine: { llm_id: 'llm_234sdertfsdsfsdf', type: 'retell-llm' },
  voice_id: '11labs-Adrian',
}) ;
console.log(agentResponse.agent_id) ;

response_engine

conversation_flow_id

json
{
  "type": "conversation-flow",
  "conversation_flow_id": "your_conversation_flow_id_here"
}

javascript
// Step 1: Create the Conversation Flow
const conversationFlowResponse = await client.conversationFlow.create({
  model_choice: { model: 'gpt-4.1', type: 'cascading' },
  nodes: [
    {
      id: 'start',
      instruction: { text: 'Greet the customer and ask how you can help them.', type: 'prompt' },
      type: 'conversation',
    },
  ],
  start_speaker: 'agent',
}) ;

javascript
// Step 2: Create the Voice Agent using the conversation_flow_id
const agentResponse = await client.agent.create({
  response_engine: { 
    type: 'conversation-flow', 
    conversation_flow_id: conversationFlowResponse.conversation_flow_id 
  },
  voice_id: '11labs-Adrian',
}) ;

response_engine

retell-llm

conversation-flow

custom-llm

nodes

client.conversationFlow.create

edges

javascript
import Retell from 'retell-sdk';
const client = new Retell({
 apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const conversationFlowResponse = await client.conversationFlow.create({
 model_choice: { model: 'gpt-4.1', type: 'cascading' },
 nodes: [
 {
 id: 'start',
 instruction: { text: 'Greet the customer and ask how you can help them.', type: 'prompt' },
 type: 'conversation',
 },
 ],
 start_speaker: 'agent',
}) ;
console.log(conversationFlowResponse.conversation_flow_id) ;

edges

destination_node_id

json
{
 "id": "start",
 "type": "conversation",
 "instruction": {
 "type": "prompt",
 "text": "Greet the customer and ask how you can help them."
 },
 "edges": [
 {
 "id": "edge_1",
 "transition_condition": {
 "type": "prompt",
 "prompt": "Customer wants to book appointment"
 },
 "destination_node_id": "book_appointment"
 }
 ]
 }

id

type

transition_condition

destination_node_id

states

edges

javascript
import Retell from 'retell-sdk';
const client = new Retell({
 apiKey: 'YOUR_RETELL_API_KEY',
}) ;
const llmResponse = await client.llm.update('16b980523634a6dc504898cda492e939', {
 begin_message: 'Hey I am a virtual assistant calling from Retell Hospital.',
}) ;
console.log(llmResponse.llm_id) ;

json
[
 {
 "name": "information_collection",
 "state_prompt": "You will follow the steps below to collect information...",
 "edges": [
 {
 "destination_state_name": "appointment_booking",
 "description": "Transition to book an appointment."
 }
 ],
 "tools": []
 },
 {
 "name": "appointment_booking",
 "state_prompt": "You will follow the steps below to book an appointment...",
 "tools": []
 }
]

name

state_prompt

destination_state_name

description

"information_collection"

7. Ask if user is interested in an in person tour.
 - if yes, transition to schedule_tour.
 - if no or hesitant, call function end_call to hang up politely and say will reach out if any other interesting properties pop up.

{{variable_name}}

"Hello {{user_name}}, I understand you're interested in {{product_name}}. How can I help you today?"

- {{user_location}} == "New York"
- {{user_age}} < 18 OR {{user_location}} == "New York"
- {{name}} exists

retell_llm_dynamic_variables

json
{
 "user_name": "John Smith",
 "product_name": "Premium Plan",
 "account_status": "active"
}